Add static site generator for building documentation #7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A PHP tool to generate a static website, based on markdown files.
Also, made the daux generate command a bit more clear.
Intended to contain docs of previous released versions.
Once we have version 1.x read, all the version 0.x docs will be moved into this directory.
The release notes are to be placed in its own doc
These docs are more or less what is expected in all open source projects.
At the moment, these landing pages act as placeholders to illustrate the documentation structure
Need this for setting styles.
Also for styling purposes
This might not be 100% correct way to sort elements, but it gets the job done
This might not be very professional, however, given the circumstances it will do the trick and let visitors know that this is far from complete...
As long as we keep the current folder structure, then this warning will render nicely.
In case that we overwrite the current "next" index by accident, we can always just copy & paste the contents of this dummy scaffold, which is also ignored by default.
I wanted to avoid this, but there are a few minor issues that can only be resolved by creating a custom, such as setting the favicon. It is a "copy & paste" of the daux theme, but we can now safely adapt the things that we need.
For testing scrollbars
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR adds daux.io as our static site generator, for our markdown documentation. A custom "RSP" theme has also been developed, to style the content a bit more elegant then the provided default theme(s).
At the moment, there is no concrete documentation available. Everything is just dummy content. Yet, it is needed such that we can enable automatic build of documentation and deploy them on GitHub pages.